home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 9 / Night Owl CD-ROM (NOPV9) (Night Owl Publisher) (1993).ISO / 016a / dm_100.zip / README.TXT < prev   
Text File  |  1993-03-14  |  5KB  |  125 lines
  1. I am not much on documentation so this is as good as it gets. I'm not
  2. one for guarantees either so the only guarantee that I will make is
  3. that my program will take up disk space.  Since Bit Bucket Software
  4. had made Binkley freely available I, in the same spirit, make DelMail
  5. available.  The only thing I insist on, is to keep the original
  6. distribution file intact and unmodified.
  7.  
  8. DelMail is a utilty, for mail distributors, using BinkleyTerm, to
  9. automatically delete old and or undelivered mail.  The command line
  10. parameters allows you the flexability to be strict or lenient.
  11.  
  12. Entering DelMail with -? or an invalid parameter will produce the
  13. following help:
  14.  
  15. Usage :DelMail -o<outbound path> -r<report file name> -t -b
  16.                -l<min days> -h<max days> -k<kb limit> -x<xcept file>
  17.                -a<action file>  
  18.  
  19. -o<outbound path> Your outbound path, DEFAULT: Current Dir
  20. -r<rpt file name> Report file name, DEFAULT: DELMAIL.RPT
  21. -l<min days> Minimum number of days mail is kept, DEFAULT: 1 day
  22. -h<max days> Maximum number of days mail is kept, DEFAULT: 2 days
  23. -k<kb limit> Max KB mail a node can have, DEFAULT: 0KB
  24. -x<xcept filename> Exception file name, DEFAULT: None
  25. -t  Test mode flag, report only, do not delete mail, DEFAULT: OFF
  26. delete mail
  27. -b  Brief report flag.  Only report deleted mail, DEFAULT: OFF
  28. -a <action file> History file of deleted mail, DEFAULT: OFF
  29.  
  30.  
  31. In all cases mail will not be deleted if it is less than <min days>
  32. old, and will always be deleted if older than max days.  If a nodes
  33. total mail exceeds the <kb limit>, then mail older than <min days>
  34. and less than <max days> will be deleted, until the total mail is
  35. less than <kb limit>.  Oldest bundles are deleted first.  The
  36. following chart (courteousy of Bob Davis) may help in understanding
  37. the deletion process:
  38.  
  39.  
  40.         >MIN DAYS       >MAX DAYS       >KB     ACTION
  41.         =========       =========       ======  =======
  42.         no              --              no      none
  43.         no              --              yes     none
  44.         yes             no              no      none
  45.         yes             no              yes     delete oldest until kb left
  46.         yes             yes             --      delete all
  47.  
  48.  
  49. If the -l0 and -h0 is specified, then age checking will not be done,
  50. and mail will be deleted based on the -k parameter.  
  51.  
  52. An optional exception file can be specified for exceptions to the
  53. command line parameters -l, -h, and -k for specific nodes. For
  54. example, if the minimum days to keep mail is 2 days and the maximum
  55. is 5 days, with a KB limit of 2mb, you would run DelMail like this:
  56.  
  57. DelMail -l2 -h5 -k2000.
  58.  
  59. Now if you knew node 999/999 was going to be out of town, and you
  60. wanted to hold onto his mail for awhile, you could add this entry to
  61. the exception file:
  62.  
  63. 999/999 -h30
  64.  
  65. This would keep node 999/999 mail for 30 days.  A "%" or a ";" in the
  66. exception file is considered a comment. NOTE: ANY ERRORS FOUND IN
  67. EDITING THE EXCEPTION WILL CAUSE DELMAIL TO TERMINATE WITH NO
  68. PROCESSING.
  69.  
  70.  
  71. If all the bundles in a *.?LO file are deleted, the *.?LO file will
  72. be deleted, otherwise it will be re-written minus the deleted bundle
  73. names.
  74.  
  75. If a file attach is in the *.?LO file, it is left alone and not
  76. counted as mail.
  77.  
  78. A report, default name of DELMAIL.RPT, is produced detailing the
  79. action taken. This file name can be overridden with the "-r" command
  80. line parameter.
  81.  
  82. The "-a" command line parameter, generates a comma delimited, human
  83. readable history file of all deleted mail.  This is a running file,
  84. as it is appended to for each run of DelMail.  If you are running in
  85. testmode, entries will not be added to this file. The format of the
  86. Action file is as follows:
  87.  
  88. DelMail,        - Program name
  89. Net,            - Net deleted mail was destined for
  90. Node,           - Node deleted mail was destined for
  91. Mo,             - Month mail was deleted
  92. Day,            - Day mail was deleted
  93. Year,           - Year mail was deleted
  94. MailName,       - Name of *.?UT or mail bundle that was deleted
  95. Age,            - Age of mail at time of deletion
  96. Size,           - Size of *.?UT or mail bundle that was deleted
  97. Reason          - Reason mail was deleted
  98.  
  99.  
  100. DelMail is distributed in ZIP format and contains the following files:
  101.  
  102. DelMail.EXE     OS/2 version of DelMail compiled with Borland C/C++.
  103. DelMailD.EXE    DOS (ugh) version of DelMail compiled with Borland C/C++.
  104. README.TXT      You are read it.  A fine example of literary
  105.                 excellence, (what cha think Nick) .
  106.  
  107. If you have any question, suggestions, or bug reports (no way),
  108. please send netmail to Jim Dailey at 1:106/202.
  109.  
  110.  
  111. ****************************** CAUTION ******************************
  112. ****************************** CAUTION ******************************
  113. ****************************** CAUTION ******************************
  114.  
  115. DELMAIL IS A VERY POWERFUL UTILITY AND IF YOU ARE NOT CAREFUL, YOU
  116. COULD END UP DELETING YOUR ENTIRE OUTBOUND.
  117.  
  118. BEFORE USING IN PRODUCTION, I SUGGEST YOU USE THE -T (TEST) SWITCH TO
  119. ENSURE YOU ARE GETTING THE RESULTS YOU DESIRE.
  120.  
  121. ****************************** CAUTION ******************************
  122. ****************************** CAUTION ******************************
  123. ****************************** CAUTION ******************************
  124.  
  125.